Docs fix: Minor corrections to OpenShift guide based on downstream QE feedback #51116
Conversation
quarkus-bot
bot
added
area/docstyle
This comment has been minimized.
This comment has been minimized.
|
🎊 PR Preview c8efc06 has been successfully built and deployed to https://quarkus-pr-main-51116-preview.surge.sh/version/main/guides/
|
| [IMPORTANT] | ||
| ==== | ||
| From {project-name} 3.8, the `DeploymentConfig` object, deprecated in OpenShift, is also deprecated in {project-name}. | ||
| `Deployment` is the default and preferred deployment kind for the `quarkus-openshift` extension. | ||
| If you redeploy applications that you deployed before by using `DeploymentConfig`, by default, those applications use `Deployment` but do not remove the previous `DeploymentConfig`. | ||
| This leads to a deployment of both new and old applications, so, you must remove the old `DeploymentConfig` manually. | ||
| However, if you want to continue to use `DeploymentConfig`, it is still possible to do so by explicitly setting `quarkus.openshift.deployment-kind` to `DeploymentConfig`. | ||
| ==== | ||
|
|
There was a problem hiding this comment.
I think we should keep this one still. We have people using old versions of Quarkus and updating late.
There was a problem hiding this comment.
@sheilamjones, I have scripts/simple_replacement_list.py configured to hide this in the 3.27 product docs. You can leave this in.
There was a problem hiding this comment.
Why do you want to hide that in the product doc? You might still have customers on 3.2 that haven't updated yet. It happens.
There was a problem hiding this comment.
@gsmet As of RHBQ 3.27, the supported versions are 3.27, 3.20, and 3.15. Version 3.2 is no longer in that window.
Customers on 3.2 must migrate sequentially through supported versions, following the migration instructions for each one. They'll encounter this deprecation note in those intermediate docs where it's still relevant.
Removing outdated content from current docs reduces technical debt and keeps the guides focused on the supported upgrade paths.
However, if this approach doesn't fully address the needs of our customers, keeping it in in the downstream docs is a simple matter. How long do you think it should remain? Could we add a comment suggesting a version or time frame when it would make sense to eventually remove this information?
There was a problem hiding this comment.
So long as the text of the notice remains unchanged, we can use downstream tools to hide it from specific versions and products downstream.
There was a problem hiding this comment.
Thanks @gsmet and @rolfedh for your additional feedback. I have reverted this change upstream, so the note is back in. It will be hidden only in the IBM Build of Quarkus version because 3.27 is the first version of IBQ.
And +1 to your question @rolfedh. How long should this text and the references to 3.2 remain in the docs?
Signed-off-by: shjones <[email protected]>
Signed-off-by: shjones <[email protected]>
sheilamjones
force-pushed
the
QDOCS-1375-upstream-QE-fixes
branch
from
2219e9b to
c09dbc4
Compare
Status for workflow
|
4 participants
This PR covers correction and minor edits to the Deploy to OpenShift guide based on QE feedback downstream for the products docs for RH and IBM Build of Quarkus 3.27.0
See: https://issues.redhat.com/browse/QUARKUS-6790